/*
 * @ProjectName: 编程学习
 * @Copyright:   2019 HangZhou Yi Dev, Ltd. All Right Reserved.
 * @address:     https://yiyuery.github.io/
 * @date:        2019/5/20 20:57
 * @email:       xiazhaoyang@live.com
 * @description: 本内容仅限于编程技术学习使用，转发请注明出处.
 */
package com.example.common.api.base.response;

/**
 * <p>
 *  接口响应抽象方法定义
 * </p>
 *
 * @author Yi
 * @version v1.0.0
 * @date 2019-06-30 12:29
 * @modificationHistory=========================逻辑或功能性重大变更记录
 * @modify By: {修改人} 2019-06-30
 * @modify reason: {方法名}:{原因}
 * ...
 */
public abstract class BaseRestResponse<R, T> {

    /**
     * 请求成功返回数据
     *
     * @return
     */
    public abstract R ok();

    /**
     * 请求成功返回数据
     *
     * @param data
     * @return
     */
    public abstract R ok(T data);

    /**
     * 请求失败返回数据
     *
     * @param message
     * @return
     */
    public abstract R fail(String message);

    /**
     * 请求失败返回数据
     *
     * @param code
     * @return
     */
    public abstract R fail(Integer code);

    /**
     * 请求失败返回数据
     *
     * @param code
     * @return
     */
    public abstract R failWithLanguageKey(Integer code);

    /**
     * 请求失败返回数据
     *
     * @param code
     * @param message
     * @return
     */
    public abstract R fail(Integer code, String message);

    /**
     * 请求失败返回数据
     * @param code
     * @param message
     * @return
     */
    public abstract R fail(String code, String message);

    /**
     * 请求失败返回数据
     *
     * @param code
     * @param message
     * @param data
     * @return
     */
    public abstract R fail(Integer code, String message, T data);
}
